Product Entitlement Customer Experience API

0.0.x
(0 reviews)

Grouped and Virtual Product Entitlements

Overview

Arm licenses product offerings that can change throughout the entitlement period. The group (or collection) of entitled products can potentially differ from day to day. An example is the CPU and Physical IP offerings under the Arm DesignStart program, which can vary based on foundry agreements.

In this scenario, an entitlement is granted to a group of products based on characteristics, such as foundry or process. The group of entitled products is calculated dynamically when accessing the API.

Design

A grouped entitlement record is created for the product offering, for example DesignStart. This entitlement record has extra characteristics (usually contained within the rights object) defining the scope of product entitlement within the group. The grouped entitlement record is the parent of all virtual (dynamic) product entitlements.

Virtual product entitlements ("characteristics.virtual": true) are derived dynamically at runtime from grouped ("characteristics.grouped": true) product entitlements. Virtual product entitlements inherit most of their properties from their grouped parent entitlement.

Grouped and virtual entitlements only apply when you have rights to download ("rightTo": "download").

Considerations

When downloading with the API, the client iterates through the virtualEntitlements array to find relevant products, releases, and artifacts.

Example

{
    "id": "100",
    "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100",
    "customer": {
        "id": "0001",
        "name": "A_Company",
        "uri": "https://id.arm.com/customer/0001",
        "blocked": false
    },
    "product": {
        "id": "DESIGN_START",
        "name": "Design Start PDG",
        "standardDeliveryMethod": "ipDelivery",
        "uri": "https://id.arm.com/product/products/DESIGN_START"
    },
    "salesOrderItem": {
        "id": "123",
        "salesOrder": {
            "id": "567",
            "uri": "https://id.arm.com/sales-order/orders/567"
        },
        "eccn": "0013",
        "soldThrough": "design-start",
        "uri": "https://id.arm.com/sales-order/order-items/123"
    },
    "contract": {
        "id": "345",
        "uri": "https://id.arm.com/contract/345"
    },
    "validFrom": "2022-03-29",
    "activationDate": "2022-03-29",
    "validTo": "2023-03-31",
    "status": "active",
    "setupComplete": true,
    "productAvailable": false,
    "characteristics": {
        "free": false,
        "grouped": true,
        "groupedType": "DesignStart",
        "virtual": false,
        "requestAccess": false
    },
    "rightTo": "download",
    "rights": {
        "maintenanceFrom": "2022-03-29",
        "maintenanceTo": "2023-05-19",
        "designStart": [
            {
                "foundry": "SE"
            },
            {
                "foundry": "TSMC"
            },
            {
                "foundry": "UMC"
            }
        ],
        "qualities": [
            {
                "quality": "rel"
            },
            {
                "quality": "eac"
            }
        ],
        "physicalIpViews": [
            "frontend"
        ]
    },
    "compliance": {
        "eccnRestricted": false,
        "status": "compliant",
        "statusReason": "test",
        "allowedCountries": [
            {
                "id": "non-sanctioned",
                "uri": "https://id.arm.com/locations/country-groups/non-sanctioned"
            }
        ]
    },
    "virtualEntitlements": [
        {
            "id": "332994.SE35CF001",
            "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100.SE35CF001",
            "product": {
                "id": "SE35CF001",
                "uri": "https://id.arm.com/product/products/SE35CF001",
                "name": "HD Via Prog ROM MVt",
                "foundry": [
                    "SE"
                ],
                "process": "14LPP"
            },
            "characteristics": {
                "virtual": true
            },
            "rights": {
                "physicalIpViews": [
                    "frontend"
                ]
            },
            "parentEntitlement": {
                "id": 100,
                "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100"
            },
            "links": {
                "releases": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100.SE35CF001/releases/",
                "download-history": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100.SE35CF001/rights/download/history"
            }
        }
    ],
    "history": {
        "createdAt": "2022-03-29T18:12:45.45Z",
        "createdBy": "Arm Employee",
        "lastChangedBy": "arm_employee@arm.com",
        "lastChangedAt": "2022-04-19T07:30:42.42Z"
    },
    "links": {
        "users": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100/users",
        "releases": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100/releases/",
        "download-history": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/100/rights/download/history"
    }
}

Reviews